home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 20 / Cream of the Crop 20 (Terry Blount) (1996).iso / image / acl30bsx.zip / ACL.DOC < prev    next >
Text File  |  1996-06-25  |  18KB  |  349 lines
  1. -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  2.              SCi's New Animation Compiler (ACL) User's Manual
  3.  
  4.           "Silicon Creations, Inc - Powers To Be Reckoned With"
  5.  
  6.                Copyright (c) 1996 by Branislav L. Slantchev
  7.                        Last updated on Jun 24, 1996
  8. -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  9.  
  10. ─────────────────────────────────────────────────────────────────────────────
  11. ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ OVERVIEW ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░
  12. ─────────────────────────────────────────────────────────────────────────────
  13.  
  14.     ACL is the maintenance program for the data files used by programs such
  15. as Enterz (version 2.16 or later) and Morez. These are similar to the KAK
  16. animations, except they are easier and more efficient to access. They are
  17. intended to replace the .KAF files completely. I have already converted all
  18. KAF prompts from the previous releases of Enterz into ACL animations. This
  19. time, there is no full-screen interface, but rather, ACL is fully command
  20. line driven which makes a whole lot faster and smaller (i.e. suitable for
  21. inclusion with your own programs). Read the following section for further
  22. information about this.
  23.  
  24.     You can use ACL to create or maintain your own archives with animations
  25. (and with the new PB-Lib, they can be a mix of ANSi and PCB-style files).
  26. You can also use ACL to merge or edit archives distributes with other
  27. programs. This makes it very easy to add new animations to your existing
  28. programs without much more to do. The original 'Press Enter' prompt archive
  29. comes with 431 prompts. This is the largest collection that I am aware of
  30. and all ACL-compliant programs have instant access to them!
  31.  
  32.     You do not need ACL to run any other software. This program is strictly
  33. for the maintenance of the sets of two related files. All ACL-compliant
  34. programs that you receive should have at least two file (.ADT and .AiX) and
  35. those are ready to go. You can adjust various aspects of the animations with
  36. ACL, such as define the speed or the starting column for those records. You
  37. can also deleted, export or simply display records with it (ANSi.SYS must be
  38. installed for the latter to work).
  39.  
  40. ─────────────────────────────────────────────────────────────────────────────
  41. ░░░░░░░░░░░░░░░░░░░░░░ LICENSE AND DISTRIBUTION RIGHTS ░░░░░░░░░░░░░░░░░░░░░░
  42. ─────────────────────────────────────────────────────────────────────────────
  43.  
  44.     ACL v3.0 Copyright (c) 1995, 1996 Branislav L. Slantchev
  45.  
  46.     ACL (executable, source and this document) is copyrighted material that
  47. you can use free of charge. Please, understand that it is not in the public
  48. domain. Read the full text of the license terms and conditions in the file
  49. 'Copying.Doc' which comes in the archive.
  50.  
  51.     This program is free software; you can redistribute it and/or modify it
  52. under the terms of the GNU General Public License as published by the Free
  53. Software Foundation; either version 2 of the License, or (at your option)
  54. any later version. This program is distributed in the hope that it will be
  55. useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
  56. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
  57. Public License for more details. You should have received a copy of the
  58. GNU General Public License along with this program; if not, write to the
  59. Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  60.  
  61.     Note that the files generated by this program are in no way considered
  62. part of it and are not covered by the license. You can distribute them as
  63. you see fit. You are not allowed to charge money for the program or any
  64. derivatives of it without express written permission from the author. This
  65. is mainly to prevent others from making money off my code. Note that this
  66. does not apply to programs that are using the animation files - those are
  67. left to your discretion. You can distribute ACL and this manual with your
  68. programs free of charge provided that you leave the copyright notices intact
  69. in the executable and the manual and provided that you state in a prominent
  70. place in your documentation that your program is ACL-compliant.
  71.  
  72. ─────────────────────────────────────────────────────────────────────────────
  73. ░░░░░░░░░░░░░░░░░░░░░░░░░░░░ COMMAND LINE OPTIONS ░░░░░░░░░░░░░░░░░░░░░░░░░░░
  74. ─────────────────────────────────────────────────────────────────────────────
  75.  
  76.     ACL's command line interface resembles that of ARJ (tm). It consists
  77. of a single letter command and other options following it. For a quick
  78. summary of the options, run ACL without parameters. Note that the commands
  79. and options are case-sensitive. The general syntax is:
  80.  
  81.                     ACL [Command] <Option> <Option...>
  82.  
  83.     By default, ACL will use the two files named A.ADT and A.AiX. You can
  84. change this with the '-o' option. You can use any of the following commands:
  85.  
  86.     a (Add)
  87.     -------------------------------------------------------------------------
  88.         This command adds new records to the archive. You must use the '-f'
  89.         option to specify the file(s) to be processed. Refer to the note on
  90.         formats for further details as well as the '-r' option for importing
  91.         RemoteAccess-compatible animations. You can use the '-p' and '-c'
  92.         options to specify the speed and column numbers or the '-i' option
  93.         to have the program prompt you along the way. Note that with the '-r'
  94.         option, the column information will be extracted from the data file.
  95.  
  96.     l (List)
  97.     -------------------------------------------------------------------------
  98.         List the records in the archive. This command with display each
  99.         record's number, length, size, speed, lines and offset in the data
  100.         file. Use it to obtain a quick summary of the data files. You can
  101.         use the '-o' option to change the default archive names.
  102.  
  103.     x (Extract)
  104.     -------------------------------------------------------------------------
  105.         Extract records from the archive. This command is used to extract
  106.         a single record. You must use the '-#' option to specify the record
  107.         number. You can export all records with '-#0'. The records will be
  108.         stored in files named 'DUMPnnnn.ACL', where 'nnnn' is the record
  109.         number. These files are directly importable back into ACL archives
  110.         except that the display speed information will be lost. The files
  111.         are compatible with Synopsis' RemoteAccess prompt files.
  112.  
  113.     m (Merge)
  114.     -------------------------------------------------------------------------
  115.         This command merges several ACL datasets. Note that you must have
  116.         the two files for each dataset. You must specify the '-f' option
  117.         to give the name of the ACL dataset you are merging. You can use the
  118.         '-o' option to change the name of the dataset you are merging into.
  119.         Note that with the '-f' option you need to specify the name and the
  120.         extension of the '.ADT' file.
  121.  
  122.     d (Delete)
  123.     -------------------------------------------------------------------------
  124.         This command delets a single record from the ACL dataset. You must
  125.         use the '-#' option to specify the record number. This operation is
  126.         not reversible: the record is physically removed immediately.
  127.  
  128.     s (Show)
  129.     -------------------------------------------------------------------------
  130.         This command displays a record. You can use the '-p' and '-c' options
  131.         to control the speed and the starting column. You must use the '-#'
  132.         option to specify the record number to display. Note that the command
  133.         requires ANSi.SYS or compatible to be installed on your system.
  134.  
  135.     e (Edit)
  136.     -------------------------------------------------------------------------
  137.         Edit a record's speed and column data. Note that you must use the
  138.         '-#' option to specify the record's number. You can also use the
  139.         '-i' option to have the program prompt you for the parameters or
  140.         you can use the '-p' and '-c' options to specify them on the command
  141.         line.
  142.  
  143.     k (Copy KAF records)
  144.     -------------------------------------------------------------------------
  145.         This command is used to copy record definitions from existing KAF
  146.         files. You must spe